<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>simGetObjectHandleEx</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>

<body>

<div align="center">
<table class=allEncompassingTable >
 <tr>
  <td >
<p><a href="../../index.html" TARGET="_top"><img src="../images/homeImg.png"></a></p>

<h1>Regular API function</h1>
<h3 class=subsectionBar><a name="simGetObjectHandleEx" id="simGetObjectHandleEx"></a>simGetObjectHandleEx</h3>
<table class=apiTable>
<tr class=apiTableTr> 
<td class=apiTableLeftDescr>
Description 
</td> 
<td class=apiTableRightDescr>Retrieves an object handle based on its path and alias. See also <a href="simIsHandle.htm">simIsHandle</a> and <a href="simGetObjectUniqueIdentifier.htm">simGetObjectUniqueIdentifier</a>.</td>
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCSyn>
C synopsis
</td> 
<td class=apiTableRightCSyn>simInt simGetObjectHandleEx(const simChar* objectPath,simInt index,simInt proxy,simInt options)</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCParam>C parameters</td> 
<td class=apiTableRightCParam>
<div><strong>objectPath</strong>: the path and alias of the object to find. See the section on <a href="../accessingSceneObjects.htm">accessing scene objects</a> for details.</div>
<div><strong>index</strong>: fetches the n-th object (zero based index) that satisfies the object path. -1 returns the first object that satisfies the object path.</div>
<div><strong>proxy</strong>: if different from -1, specifies an object handle that identifies a hierarchy tree to search in.</div>
<div><strong>options</strong>: bit-coded. bit0 set (i.e. 1): errors are silent.</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCRet>
C return value
</td> 
<td class=apiTableRightCRet>
<div>handle of object or -1 if operation was not successful</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLSyn>
Lua synopsis
</td> 
<td class=apiTableRightLSyn>From Lua, call <a href="simGetObjectHandle.htm">sim.getObjectHandle</a> instead.</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLParam>Lua parameters</td> 
<td class=apiTableRightLParam>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLRet>
Lua return values
</td> 
<td class=apiTableRightLRet>
</td> 
</tr> 

<tr class=apiTableTr> 
<td class=remApiTableLeftCParam>
Remote API equiv.
</td> 
<td class=remApiTableRightCParam>
<div>B0-based remote API: <a href="../b0RemoteApi-cpp.htm#simxGetObjectHandle">simxGetObjectHandle</a></div>
<div>Legacy remote API: <a href="../remoteApiFunctions.htm#simxGetObjectHandle">simxGetObjectHandle</a></div>
</td> 
</tr> 

</table> 


<br>
</td>
</tr>
</table>
</div>
</body>
</html>
